Skip to main content

FormManagerAPI

The FormManagerAPI is a powerful API that allows users to create, manage, and process dynamic forms. This API facilitates operations such as form design, management of form instances, data updates, and retrieval of form control values.

Methods

NameDescription
DeleteDocument(projectName, formName, documentId, telemetryCollectorHolder)Deletes a document associated with a specified form instance.
Run(formInstance, cancellationToken, telemetryCollectorHolder)Executes the specified form instance.
CreateWithoutView(projectName, formName, cancellationToken, telemetryCollectorHolder)Creates a new form instance without initializing the view.
Create(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)Creates a new form instance with specified configurations.
GetFormData(projectName, formName, secretKey, telemetryCollectorHolder)Retrieves form data for a specified form instance using a secret key.
Save(formInstance, cancellationToken, telemetryCollectorHolder)Saves the specified form instance.
CheckColumnsIsUnique(projectName, formName, documentId, controlName, rows, telemetryCollectorHolder)Checks if the specified columns are unique within a set of rows in a grid control.
SaveAsDraft(formInstance, starterInfo, cancellationToken, telemetryCollectorHolder)Saves the form instance as a draft.
BatchCreateWithDocumentData(projectName, formName, documentsData, telemetryCollectorHolder)Creates multiple form instances with the specified document data in batch.
GetControlValue(projectName, formName, documentId, controlName, cancellationToken, telemetryCollectorHolder)Retrieves the value of a specified control within a form instance.
SetUniqueId(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)Sets a unique identifier for a specified form instance.
UpdateFormData(projectName, formName, formData, telemetryCollectorHolder)Updates the form data for a specified form instance.
CreateWithDocumentData(projectName, formName, documentData, telemetryCollectorHolder)Creates a new form instance with the specified document data.
SetUrl(url)Sets the API URL for requests.
CreateWithoutView(projectName, formName, documentId, readOnly, view, validate, parameters, cancellationToken, telemetryCollectorHolder)Creates a new form instance without initializing the view, with additional configurations.
Create(projectName, formName, secretKey, cancellationToken, telemetryCollectorHolder)Creates a new form instance.
UpdateStatus(projectName, formName, documentId, status, telemetryCollectorHolder)Updates the status of a specified document associated with a form instance.